home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d20 / 2dapnt14.arc / 2DAPOINT.DOC < prev    next >
Text File  |  1991-10-06  |  10KB  |  252 lines
  1. 2DaPoint                                                                Page 1
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                       ╓─╖  ╥─┐  ╓─┐  ╥─┐  ╓─┐  ╥  ╥─┐  ─┬─
  8.                       ╓─╜  ║ │  ╟─┤  ╟─┘  ║ │  ║  ║ │   │
  9.                       ╙──  ╨─┘  ╜ └  ╨    ╙─┘  ╨  ╨ ┴   ┴
  10.                      Version 1.40 Reference Guide  10/1991
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.            A totally free mail bundler for use on FTSC compliant .MSG
  20.                  files with the BinkleyTerm 2.50 FidoNet Mailer
  21.  
  22.  
  23.             Software & documentation by Ron Pritchett of 1:376/74.0
  24.  
  25.  
  26.  
  27.                     Copyright (c) 1991 Realm Software
  28.                            All Rights Reserved
  29.  
  30.  
  31.  
  32.                             Realm Software
  33.                            133 WaterView Dr
  34.                           Columbia, SC 29212
  35.  
  36.  
  37.  
  38.  
  39. 2DaPoint                                                                Page 2
  40.  
  41. INTRODUCTION
  42.  
  43.    This software was written on a whim. After noticing how well Maximus
  44.  CBCS handles point addressing, I started searching for an equally
  45.  point-aware NetMail Bundler. The idea is that the average caller/user
  46.  shouldn't have to know anything about the pseudo point network/secondary
  47.  set of addresses. The only thing I found that came close was REMAPPER by
  48.  Bob Hartman (of ConfMail fame), but this didn't work quite the way I
  49.  wanted it to & lacked a few features. Finally I downloaded a copy of the
  50.  FTSC specs & went to work on my own program. Here it is.
  51.  
  52.  
  53.   >>What it does<<
  54.  
  55.   - Full zone support.
  56.  
  57.   - Complete Message bundling (.?UT file generator) for normally addressed
  58.     messages including File Requests, File Attaches, Forwarding, Crash,
  59.     Hold, & Kill. (ie the whole 9 yards)
  60.  
  61.   - Through File Attaches between points or BBSes which can optionally be
  62.     deleted once sent. Multiple File Attaches & File Requests are supported
  63.     too.
  64.  
  65.   - Recognition of point addresses embedded within messages to send the
  66.     message to the proper host or pointnet address.
  67.  
  68.   - Address redirection (including points) via name recognition.
  69.  
  70.   - Name remapping via alias name recognition.
  71.  
  72.   >>What it doesn't do<<
  73.  
  74.   - It won't do XRobot-type automatic mailings/file attaches.
  75.  
  76.   - It won't balance your checkbook.
  77.  
  78.   - It won't fix your recently pedestrian-damaged Buick Impala for free or
  79.     even at a discount rate.
  80.  
  81. CONTROL FILE
  82.  
  83.   2DaPoint requires the presence of a control file called 2DAPOINT.CTL
  84. which must reside in the same directory the executable program is. There
  85. is no way/reason to have the control file named anything else.
  86.  
  87.   A sample configuration file with internal documentation is included. The
  88. sample is actually MY control file. It's short & sweet. Not too many options
  89. or things to go wrong. 2DaPoint is very forgiving about the information
  90. contained in the control file. If information is missing or invalid, the
  91. program will point out which additional information is needed/invalid.
  92.  
  93. 2DaPoint                                                                Page 3
  94.  
  95. The commands are listed here in alphabetical order for reference ease.
  96.  
  97.   Address <(zone:)net/node(.point)>
  98.  
  99.           Here your full address must be specified. Zone & point are not
  100.           a required portion of the address; zone 1 is assumed & .0 is
  101.           also assumed. The point portion of the address is recognized,
  102.           but is only for future expansion. It may possible to run this
  103.           program from a point system, but I haven't tried it.
  104.  
  105.   FileFwd <Kill | Save>
  106.  
  107.           This options controls whether or not a file passing thru
  108.           your node is to be killed or saved. If 'Kill' is specified,
  109.           then file will be killed by your mailer after it has been sent.
  110.           If 'Save' is specified, the file will not be killed, it'll just
  111.           sit in your inbound directory. NOTE: This only applies to
  112.           passthru files (ie they didn't originate from your node & they're
  113.           not destine to your node).
  114.  
  115.   Forward <Kill | Save>
  116.  
  117.           This options controls whether or not a message passing thru
  118.           your node is to be killed or saved. If 'Kill' is specified,
  119.           then message will be packed up & then the .MSG file will
  120.           be erased. If 'Save' is specified, the message will not be killed
  121.           just marked as 'Sent'.
  122.  
  123.   Inbound <directory>
  124.  
  125.           This is the path of your incoming file/mail directory. This is
  126.           used for passthru file attaches for your node. This way points
  127.           can send mail amongst themselves via your host or even to other
  128.           nodes or other points on other nodes.
  129.  
  130.           For Example, when a point sends a file to another point, the
  131.           subject line of the message contains the path & filename of the
  132.           file to be sent. Well, there's only a one in a million chance that
  133.           this will be the same on the both the point's & Host's computer.
  134.           2DaPoint will replace the path on the incoming message with the
  135.           directory name that you have specified. (ie where the file is now
  136.           located on the host system.)
  137.  
  138.   Mail <directory>
  139.  
  140.           This is the path to your netmail messages directory. 2DaPoint
  141.           looks here for messages that need to be sent, etc.
  142.  
  143. 2DaPoint                                                                Page 4
  144.  
  145.   Mode <Net | Node>
  146.  
  147.           This option controls whether a message bound for a point is
  148.           to be saved in a .PNT directory (for pickup or mailing) or
  149.           it's to be sent to the point's host system. If operating in
  150.           'Net' mode, any mail bound for a point in your zone & network
  151.           will be packed up for it's full 4D address & placed in a .PNT
  152.           subdirectory in your outbound mail area.
  153.           (If you're unfamiliar with the new .PNT directory format, refer
  154.           to the Binkley 2.50 documentation or the example in 2DaPoint.ctl.)
  155.  
  156.           If operating in 'Node' mode, the additional constraint of a point
  157.           being your point is added. If a message is received for your
  158.           point, then (as above) it is bundled into a .PNT directory.
  159.           Otherwise, the message is sent to that point's host. Once there
  160.           the ^ATOPT would be recognized & the message would be sent along
  161.           the proper path.
  162.  
  163.   Names
  164.           This marks the beginning of your name service addressing. One
  165.           name & address appear per line until the keyword END is
  166.           encoutered. If a message is bound for a node in your Network
  167.           or your PointNet and the name is in the control file, then the
  168.           destination in the control file is used instead of the one
  169.           embedded in the message. (Read that sentence again, I'm sure
  170.           it'll be the source of some confusion. <grin> )
  171.  
  172.           The syntax of the NAMES block is:
  173.  
  174.           Names
  175.             ( <alias1> ^) <name 1>  <address>
  176.             ( <alias2> ^) <name 2>  <address>
  177.             ........  .........
  178.             ( <aliasx> ^) <name x>  <address>
  179.           End
  180.  
  181.           Where <name> can be any numbers of words (theoretically). And
  182.           <address> is a full or partial address. "What's a partial
  183.           address?" you're asking. Well basically it means that the part
  184.           of the address that you don't explicitly enter, will be assumed
  185.           based upon what address you have specified for your address via
  186.           the ADDRESS statement. See examples in control file.
  187.  
  188.           If an <alias> is present, then any message addressed to
  189.           <alias> or <name> will be sent to <name> @ <address>. The ^
  190.           character delimites between the <alias> & <name>. See example
  191.           control file for examples that might wipe away your confusion. <g>
  192.  
  193.           Also: the <address> may be "Hold" which will simply hold the
  194.           message and not send it anywhere.
  195.  
  196. 2DaPoint                                                                Page 5
  197.  
  198.   Notify <None | OurNet | All >
  199.  
  200.           If someone sends a message to your system & it is mis-addressed
  201.           (according to the name service table) then the sender of the
  202.           message will get a notice saying that they haven't sent their
  203.           msg to the wrong address & also listed will be the correct
  204.           address.
  205.  
  206.           None   - will disable this feature.
  207.           OurNet - will only send to nodes/point in your network.
  208.           All    - will send a FYI msg back to the sender no matter what
  209.                    net or zone they're in.
  210.  
  211.   Outbound <directory>
  212.  
  213.           This is the path to your outbound mail directory. All generated
  214.           outbound bundles/packets will be placed in this directory.
  215.  
  216.   SetBit   <bitmask>
  217.   StripBit <bitmask>
  218.  
  219.           Once it's been determined that the message needs to be sent, The
  220.           bits defined here will either be turned on or off in the status
  221.           of the message. This doesn't apply to echomail destine for other
  222.           systems that has happened to land in you netmail directory.
  223.           See Control file for detailed info.
  224.  
  225.  
  226. COMMAND LINE PARAMETERS
  227.  
  228.  -B  = Use BIOS calls instead of direct video writes.
  229.  
  230.  
  231. LEGAL STUFF
  232.  
  233.   I take no reponsibility for what this program will do. It is NOT a trojan
  234. horse type program, but who knows what could happen with an incompetent user.
  235.  
  236.  
  237. CLOSING THOUGHTS
  238.  
  239.   This program has been thoroughly tested with Maximus & should work on Fido,
  240. Opus & any other FTSC-compliant BBSwares. Please report any problems
  241. encountered, if any. The lastest version can be F'req from 1:376/74 with
  242. the magic filename of 2DAPOINT.
  243.  
  244.   That's it! I'm not much on docs. I'd love to hear from you. If you thought
  245. this software is trash, helpful, lacking in a few areas, whatever!
  246.  
  247.  
  248.  
  249.  
  250.                                                   Ron Pritchett
  251.                                                   1:376/74.0
  252.